Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add contributing tips #2704

Merged
merged 6 commits into from
May 17, 2024
Merged

Conversation

JohanBertrand
Copy link
Contributor

Related Issue(s)
Has Unit Tests (y/n) N/A
Documentation Included (y/n)

Change Description

I personally spent quite some time trying to figure out how to run tests properly on my computer, specially when fpp needed to be updated for the PR to pass.

I have added here my current workflow.

Rationale

It is currently hard to figure out how to run all tests for new contributors.

Testing/Review Recommendations

My workflow with modified versions of FPP might not be the best currently. Feel free to update it with the recommended workflow.

Copy link
Collaborator

@thomas-bc thomas-bc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one comment, but thank you for compiling this info!

CONTRIBUTING.md Outdated
# Install FPP. Make sure to have sbt installed.
./compiler/install
# Copy
cp ./compiler/bin/* /usr/local/bin/ -r
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I personally do

export PATH=<path/to/fpp>/compiler/bin:$PATH

Do you think it might be better to recommend that in the guide? Forgetting to uninstall could lead to very hard to debug issues

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can also give the destination in the install line....and place it into your virtual environment.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I definitely think that there is a better way than mine.

I feel like, ideally, there should be a setup.py that we could use to install the fpp packages with pip install . after the command compile/install has been called. I know the setup.py file existed in the past (https://github.com/nasa/fpp/blob/v2.0.1/setup.py), but I'm not sure what was the reason why it was removed.

As you suggested, the export PATH way is already better than what I am currently doing.

I have to say that I am not using any virtual environment in my development routine right now, since I am having a dedicated docker image for fprime. However, what would be the command to add it to the virtual environment?
Maybe both approaches can be suggested.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

@JohanBertrand JohanBertrand May 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes it works. I updated the readme with the link, and added some clang-tidy commands we discussed in other PR.

Let me know if there is something else to change

@JohanBertrand
Copy link
Contributor Author

@LeStarch @thomas-bc is there anything else to be done in this MR?

@LeStarch
Copy link
Collaborator

PI tests are passing, but failing to upload artifacts. Will pass this!

@LeStarch LeStarch merged commit a683ec3 into nasa:devel May 17, 2024
33 of 34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants